/*
 * Copyright 2010-2012 Susanta Tewari. <freecode4susant@users.sourceforge.net>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package test.coalescent.data;

import commons.util.test.TestDataMeasure;

import java.math.BigInteger;

/**
 * The genealogy count measure defined on a {@code PopGenDataTD}. The {@code getTestDataUID()}
 * method should correspond to a {@code PopGenDataTD} instance. Genealogy count depends on the
 * data type, implementation type (how is the information encoded) and the recursion.
 *
 * @author Susanta Tewari
 */
public interface PopGenDataTDGenealogyCount extends TestDataMeasure {

    /**
     * The genealogy count of the {@code PopGenData} created by {@code PopGenDataTD} referred to
     * via {@code getTestDataUID()}.
     *
     * @return the data genealogy count
     */
    BigInteger getGenealogyCount();
}
